/**
* **** BEGIN LICENSE BLOCK *****
* Version: CPL 1.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Common Public
* License Version 1.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/cpl-v10.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2009-2011 Yoko Harada <yokolet@gmail.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the CPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the CPL, the GPL or the LGPL.
* **** END LICENSE BLOCK *****
*/
package org.jruby.embed.jsr223;
import java.util.Set;
import javax.script.Bindings;
import javax.script.ScriptContext;
import javax.script.ScriptEngine;
import org.jruby.embed.AttributeName;
import org.jruby.embed.LocalVariableBehavior;
import org.jruby.embed.ScriptingContainer;
import org.jruby.embed.variable.TransientLocalVariable;
import org.jruby.embed.variable.VariableInterceptor;
/**
* A collection of JSR223 specific utility methods.
*
* @author Yoko Harada <yokolet@gmail.com>
*/
public class Utils {
/**
* Gets line number value from engine's attribute map.
*
* @param context ScriptContext to be used to the evaluation
* @return line number
*/
static int getLineNumber(ScriptContext context) {
Object obj = context.getAttribute(AttributeName.LINENUMBER.toString(), ScriptContext.ENGINE_SCOPE);
if (obj instanceof Integer) {
return (Integer)obj;
}
return 0;
}
/**
* Gets a receiver object from engine's attribute map.
*
* @param context ScriptContext to be used to the evaluation
* @return receiver object or null if the attribute doesn't exist
*/
static Object getReceiver(ScriptContext context) {
return context.getAttribute(AttributeName.RECEIVER.toString(), ScriptContext.ENGINE_SCOPE);
}
static String getFilename(ScriptContext context) {
Object filename = context.getAttribute(ScriptEngine.FILENAME);
return filename != null ? (String)filename : "<script>";
}
static boolean isTerminationOn(ScriptContext context) {
Object obj = context.getAttribute(AttributeName.TERMINATION.toString());
if (obj != null && obj instanceof Boolean && ((Boolean) obj) == true) {
return true;
}
return false;
}
static void preEval(ScriptingContainer container, ScriptContext context) {
Object receiver = getReceiverObject(context);
Bindings bindings = context.getBindings(ScriptContext.ENGINE_SCOPE);
Set<String> keys = bindings.keySet();
for (String key : keys) {
Object value = bindings.get(key);
Utils.put(container, receiver, key, value, context);
}
//container.setReader(context.getReader());
container.setWriter(context.getWriter());
container.setErrorWriter(context.getErrorWriter());
// if key of globalMap exists in engineMap, this key-value pair should be skipped.
bindings = context.getBindings(ScriptContext.GLOBAL_SCOPE);
if (bindings == null) return;
keys = bindings.keySet();
for (String key : keys) {
if (container.getVarMap().containsKey(key)) continue;
Object value = bindings.get(key);
put(container, receiver, key, value, context);
}
}
private static Object getReceiverObject(ScriptContext context) {
if (context == null) return null;
return context.getAttribute(AttributeName.RECEIVER.toString(), ScriptContext.ENGINE_SCOPE);
}
static void postEval(ScriptingContainer container, ScriptContext context) {
if (context == null) return;
Object receiver = getReceiverObject(context);
Bindings engineMap = context.getBindings(ScriptContext.ENGINE_SCOPE);
int size = engineMap.keySet().size();
String[] names = engineMap.keySet().toArray(new String[size]);
for (int i=0; i<names.length; i++) {
if (shouldLVarBeDeleted(container, names[i])) {
engineMap.remove(names[i]);
}
}
Set<String> keys = container.getVarMap().keySet();
if (keys != null && keys.size() > 0) {
for (String key : keys) {
Object value = container.getVarMap().get(key);
engineMap.put(adjustKey(key), value);
}
}
Bindings globalMap = context.getBindings(ScriptContext.ENGINE_SCOPE);
if (globalMap == null) return;
keys = globalMap.keySet();
if (keys != null && keys.size() > 0) {
for (String key : keys) {
if (engineMap.containsKey(key)) continue;
Object value = container.getVarMap().get(receiver, key);
globalMap.put(key, value);
}
}
}
private static Object put(ScriptingContainer container, Object receiver, String key, Object value, ScriptContext context) {
Object oldValue = null;
String adjustedKey = adjustKey(key);
if (isRubyVariable(container, adjustedKey)) {
boolean sharing_variables = true;
Object obj = context.getAttribute(AttributeName.SHARING_VARIABLES.toString(), ScriptContext.ENGINE_SCOPE);
if (obj != null && obj instanceof Boolean && ((Boolean) obj) == false) {
sharing_variables = false;
}
if (sharing_variables || "ARGV".equals(adjustedKey)) {
oldValue = container.put(receiver, adjustedKey, value);
}
} else {
if (adjustedKey.equals(AttributeName.SHARING_VARIABLES.toString())) {
oldValue = container.setAttribute(AttributeName.SHARING_VARIABLES, value);
} else {
oldValue = container.setAttribute(adjustedKey, value);
}
/* Maybe no need anymore?
if (container.getAttributeMap().containsKey(BACKED_BINDING)) {
Bindings b = (Bindings) container.getAttribute(BACKED_BINDING);
b.put(key, value);
}
*
*/
}
return oldValue;
}
static boolean isRubyVariable(ScriptingContainer container, String name) {
return VariableInterceptor.isKindOfRubyVariable(container.getProvider().getLocalVariableBehavior(), name);
}
private static String adjustKey(String key) {
if (key.equals(ScriptEngine.ARGV)) {
return "ARGV";
} if ("ARGV".equals(key)) {
return ScriptEngine.ARGV;
} else {
return key;
}
}
private static boolean shouldLVarBeDeleted(ScriptingContainer container, String key) {
LocalVariableBehavior behavior = container.getProvider().getLocalVariableBehavior();
if (behavior != LocalVariableBehavior.TRANSIENT) return false;
return TransientLocalVariable.isValidName(key);
}
}